home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / misc / man35.lha / Man3.5 / DOCS / English / Man.DOC next >
Text File  |  1994-11-21  |  8KB  |  265 lines
  1. Document Man
  2.  
  3. Man - © 1993,1994 by Markus Hillenbrand
  4. ---------------------------------------
  5.  
  6. Man is a program to view texts and docs from Shell or WB. Therefore the
  7. Commodity has to be started.
  8.  
  9.  
  10. 1. Requirements
  11. ~~~~~~~~~~~~~~~
  12.  
  13. You need:            - asl.library         v37
  14.                      - intuition.library   v37
  15.                      - gadtools.library    v37
  16.                      - graphics.library    v37
  17.                      - dos.library         v37
  18.              - icon.library        v37
  19.              - commodities.library v37
  20.                      - workbench.library   v37
  21.                      - utility.library     v37
  22.              - reqtools.library    v38    (c) by Nico François
  23.  
  24. Supported:           - locale.library      v38
  25.  
  26. Recommended:         - a harddisk to use help-texts efficiently
  27.                      - "MultiView" from OS3.0 to read .guide files
  28.                      - "Amigaguide" from OS2.0, if you don´t have 3.0
  29.  
  30.  
  31. 2. Installer
  32. ~~~~~~~~~~~~
  33.  
  34. As the program 'installer' (© by Commodore) is not freely distributable
  35. and it is needed for installation, you must be sure to have it in the
  36. path of your shell (e.g. C:, SYS:Utilities, ...). You can find the program
  37. on your workbench-disk for OS2.0, OS2.1 or OS3.0.
  38.  
  39. If your version of installer does not work with the installation-script
  40. of man, you may install 'man' yourself:
  41.  
  42.    1. Click on the icon 'man' and drag it to 'Workbench:WBStartUp'.
  43.    2. If you have OS2.1, copy the directory 'Catalogs' to 'Locale:Catalogs'.
  44.  
  45.  
  46. 3. ToolTypes
  47. ~~~~~~~~~~~~
  48.  
  49. Starting the program, it searches for the following Tooltypes:
  50.  
  51. 3.1. CX_PRIORITY
  52. ~~~~~~~~~~~~~~~~
  53.  
  54. CX_PRIORITY=x, where x stands for a value with -128<x<128. This value
  55. represents the priority for the commodity. Default is 0.
  56.  
  57. 3.2. CX_POPKEY
  58. ~~~~~~~~~~~~~~
  59.  
  60. Here you can enter a hotkey which will open the config-window when 
  61. pressed. Default is 'ctrl lalt m'.
  62.  
  63. 3.3. DONOTWAIT
  64. ~~~~~~~~~~~~~~
  65.  
  66. This Entry is not important, it´s only neccesary for system-startup.
  67.  
  68. 3.4. HOTKEY
  69. ~~~~~~~~~~~
  70.  
  71. Here you can enter a hotkey which will open the text-requester when 
  72. pressed. Default is 'ctrl help'.
  73.  
  74. 3.5. DATA
  75. ~~~~~~~~~
  76.  
  77. Here you can enter a filename under which the lists of texts will be 
  78. saved. Default is 'Work:Man.LST'.
  79.  
  80. 3.6. GUIDE
  81. ~~~~~~~~~~
  82.  
  83. Here you can enter the program to use if you want to read a .guide file.
  84.  
  85. 3.7. DVI
  86. ~~~~~~~~
  87.  
  88. Here you can enter the program to use if you want to read a .dvi file.
  89.  
  90. 3.8. UNIX
  91. ~~~~~~~~~
  92.  
  93. Here you can enter the program to use if you want to read a standard 
  94. UNIX man page.
  95.  
  96. 3.9. PROGRAM
  97. ~~~~~~~~~~~~~
  98.  
  99. Here you can enter the program to use if you want to read a plain text
  100. file. The program enteres in the configuration window can be saved here
  101. if you click 'save' in the configuration window.
  102.  
  103. 3.10. REQX and REQY
  104. ~~~~~~~~~~~~~~~~~~~
  105.  
  106. Here you can specify the top left edge of the requester which opens when
  107. you press the hotkey or enter 'man' in your shell. The actual window
  108. position will be saved here if you click 'enter' in the configuration 
  109. window.
  110.  
  111. 3.11. WINX and WINY
  112. ~~~~~~~~~~~~~~~~~~~
  113.  
  114. Here you can specify the top left edge of the configuration window. The
  115. actual window position will be saved here if you click 'enter' in the 
  116. configuration window.
  117.  
  118. 3.12. REQENTRIES
  119. ~~~~~~~~~~~~~~~~
  120.  
  121. Here you can enter the number of visible entries in the listview of the
  122. requester. If your number is too great, a new value will be calculated.
  123.  
  124. 4. Configuration
  125. ~~~~~~~~~~~~~~~~
  126.  
  127. To configure the program, type "man -c" or "man -config" in your shell.
  128. A window opens where you can enter several specifications.
  129.  
  130. This window can also be opened by double-clicking the program-icon or
  131. by activating the gadget 'Activate Window' in the program 'Exchange'
  132. (© by Commodore).
  133.  
  134. The opened window is an AppWindow. This means that you can drop icons
  135. on it. These icons will be added to the list in the listviewgadget.
  136.  
  137. The window is devided into three parts:
  138.  
  139. 4.1. List of Help-Texts
  140. ~~~~~~~~~~~~~~~~~~~~~~~
  141.  
  142. In the upper halp of the window there is a listview-gadget, where all
  143. actual texts are shown. On the right side there are some gadgets:
  144.  
  145. 4.1.1. Add
  146. ~~~~~~~~~~
  147.  
  148. If you activate this gadget, a requester wille be opened which lets you
  149. add one single textfile to the list of texts.
  150.  
  151. 4.1.2. Delete
  152. ~~~~~~~~~~~~
  153.  
  154. The text highlighted in the listview will be deletet by pressing this gadget.
  155.  
  156. 4.1.3. Edit
  157. ~~~~~~~~~~~
  158. The text highlighted in the listview can be edited by pressing this gadget
  159. (i.e. if the path has changed).
  160.  
  161. 4.1.4. ScanDir
  162. ~~~~~~~~~~~~~~
  163.  
  164. With this gadget you can search through a whole directory in order to find
  165. some texts. All subdirectories will be searched as well. This is especially
  166. useful by configuring the program for the first time, because it saves a 
  167. lot of time.
  168.  
  169. 4.1.5. DelAll
  170. ~~~~~~~~~~~~~
  171.  
  172. That means: delete all. This gadget lets you delete the whole list of
  173. texts. 
  174.  
  175. 4.2. Program to show texts
  176. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  177.  
  178. Here you can enter the program to use for viewing and reading texts (maybe 
  179. your favourite text-reader). The gadget on the right opens a requester.
  180.  
  181. 4.3. Standard-Gadgets
  182. ~~~~~~~~~~~~~~~~~~~~~
  183.  
  184. With 'Save' the actual list of texts will be saved. With 'Hide' the win-
  185. dow will be closed and with 'Quit' the program will be removed from memory.
  186. (Changes will NOT be saved).
  187.  
  188.  
  189. 5. Shell-usage
  190. ~~~~~~~~~~~~~~
  191.  
  192. To read a text from shell, you have to add its name in the command line.
  193. Here you must not enter the suffix! "Man lha" for example searches for
  194. lha.doc, lha.dok, lha.man, and ... in the list.
  195. This text will then be shown with your preferred text-reader. If you enter 
  196. "man -l" you´ll get a list of all texts.
  197. If you call man without any parameter, a window os opened where you can
  198. select a text.
  199. If you enter a pattern (#?, ? etc.), all texts matching this pattern will be
  200. listed. If only one text matches, it will be shown immediately.
  201. With "man -q" you can unload the commodity.
  202.  
  203. 6. Localization under WB2.1+
  204. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  205.  
  206. Since Workbench 2.1 the program can be localized, i.e. it can be translated
  207. into several languages. Therefor I added the C source of the catalog. In the
  208. original version only German, Swedish and English are supported.
  209. The C source can easily be changed, and with a suitable program (e.g. MakeCat 
  210. - © Paladin-Software etc.) you can rebuild the catalog.
  211. If you have created a new catalog it would be nice if you send me the new
  212. C source via e-mail. Perhaps I can add the new language in a newer version
  213. of man.
  214.  
  215.  
  216. 7. Copyright
  217. ~~~~~~~~~~~~
  218.  
  219. CAUTION:
  220. Since version 3.1, 'man' is CARDWARE. So you'll have to send me a postcard
  221. of your country/home/city/... with a few words from you (in your own 
  222. language ?) if you use 'man' regularly.
  223.  
  224. 'Man' is Copyright (C) 1993 Markus Hillenbrand and it's freely distributable
  225. as long as all of its files are included in their original form without
  226. additions, deletions, or modifications of any kind, and only a nominal fee
  227. is charged for its distribution. This software is provided *AS IS* without 
  228. warranty of any kind, either expressed or implied. By using 'Man', you agree
  229. to accept the entire risk as to the quality and performance of the program.
  230.  
  231. Of course, it was tested rather extensively before it was released...
  232.  
  233.  
  234. 8. Address of the author
  235. ~~~~~~~~~~~~~~~~~~~~~~~~
  236.  
  237. Here´s my address (bug-report, suggestions or something like that, and the
  238. postcard):
  239.  
  240.            Markus Hillenbrand
  241.            Weserstrasse 9
  242.            36124 Eichenzell-Loeschenrod 
  243.  
  244.            GERMANY
  245.  
  246.  
  247. or e-mail: m_hillen@informatik.uni-kl.de
  248.  
  249.  
  250. 9. Man pages
  251. ~~~~~~~~~~~~
  252.  
  253. If you intend to write a man page for this archive, please read the hints
  254. and tips in the directory "ManPages". 
  255. If you are interested in a package of man pages for the original AmigaDOS
  256. commands, feel free to contact Lars Oloffson (e-mail: pt93lo@pt.hk-r.se).
  257.  
  258. 10. Thanks
  259. ~~~~~~~~~~
  260.  
  261. - Nico François for his famous reqtools.library
  262. - Lars Oloffson for his swedish catalog
  263. - Marcus Flehmig for beta-testing
  264. - Stephan Sürken for his program 'Text2Guide'
  265.